/*-
 * VPF.java          TP-Validity-Period-Format (TP-VPF)
 *
 * $LastChangedBy: stein $
 * $LastChangedRevision: 95 $
 * $LastChangedDate: 2007-02-13 16:19:24 +0000 (Tue, 13 Feb 2007) $
 * $HeadURL: svn://localhost/SMS/src/com/googlecode/attention/sms/pdu/VPF.java $
 *
 * Copyright (c) 2007, Stein Gunnar Bakkeby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Stein Gunnar Bakkeby nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.attention.sms.pdu;

/**
 * TP-Validity-Period-Format (TP-VPF).
 * <BR>
 * The TP-Validity-Period-Format is a 2-bit field, located
 * within bit no 3 and 4 of the first octet of SMS-SUBMIT,
 * and to be given the following values:
 * <BR>
 * <BR><TABLE>
 * <TR><TD>bit4</TD><TD>bit3</TD><TD></TD></TR>
 * <TR><TD>0</TD><TD>0</TD><TD>TP-VP field not present</TD></TR>
 * <TR><TD>1</TD><TD>0</TD><TD>TP-VP field present - relative format</TD></TR>
 * <TR><TD>0</TD><TD>1</TD><TD>TP-VP field present - enhanced format</TD></TR>
 * <TR><TD>1</TD><TD>1</TD><TD>TP-VP field present - absolute format</TD></TR>
 * </TABLE>
 * <BR>Any unsupported value may be rejected by the SC by returning
 * the "TP-VPF not supported" TP-FCS value in the SMS Submit Report
 * for RP-Error.
 * 
 * @author Stein Gunnar Bakkeby
 */
public enum VPF {

  /** VP field not present. */
  FIELD_NOT_PRESENT(0),
  /**
   * Enhanced format (7 octets).
   *
   * @see VPEnhancedTime
   */
  ENHANCED_FORMAT(0x8), // B3
  /**
   * Relative format (one octet).
   *
   * @see VPRelativeTime
   */
  RELATIVE_FORMAT(0x10), // B4
  /**
   *  as SCTS (7 octets).
   *
   * @see SCTS
   */
  ABSOLUTE_FORMAT(0x18); // B4|B3
  
  /** The binary value of the VPF. */
  final int value;
  
  private VPF(final int value) {
    this.value = value;
  }
  
  /**
   * This will parse an integer and return the respective VPF enum value.
   * The method will return the enum based on bit3 and 4 of the integer.
   * 
   * @param value The integer to parse
   * @return The respective UDHI enum value
   */
  public static VPF parse(int value) {
    if (value >= 4) value &= 0x18; 
    switch (value & 0x30) {
    case 0:
      return FIELD_NOT_PRESENT;
      
    case 1:
    case 0x8:
      return ENHANCED_FORMAT;
      
    case 2:
    case 0x10:
      return RELATIVE_FORMAT;
      
    case 3:
    case 0x18:
      return ABSOLUTE_FORMAT;
      
    default:
      return FIELD_NOT_PRESENT;
    }
  }
}